Skip to content

WIP: cargo test --doc #1302

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 9 commits into
base: develop
Choose a base branch
from
Draft

WIP: cargo test --doc #1302

wants to merge 9 commits into from

Conversation

dannywillems
Copy link
Member

No description provided.

Add comprehensive WebRTC documentation to help engineers understand WebRTC
fundamentals and OpenMina's implementation. The documentation covers NAT
traversal, signaling protocols, ICE candidates, and OpenMina's specific
WebRTC architecture including host resolution, signaling methods, and
cryptographic authentication.

Highlights Web Node importance for browser-based Mina protocol nodes and
includes documentation link in the WebRTC module for easy reference.
Always good to have unit test for this kind of small methods.
Bugs in parsing can cause the process to exit, therefore it is important to be
sure that the methods handle the cases correctly.
It is multiple times referenced in the WebRTC document. Therefore it is worth
having a small documentation to help when going through the documentation.
@dannywillems dannywillems marked this pull request as draft August 13, 2025 17:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant